home *** CD-ROM | disk | FTP | other *** search
/ Speccy ClassiX 1998 / Speccy ClassiX 98.iso / amiga_system / the_aminet / comm / bbs / maxsutils.lha / MaxUtils / MaxiText24.lha / Maxi-Text.insert < prev    next >
Text File  |  1993-09-09  |  10KB  |  302 lines
  1.  
  2.              Maxi-Text Version 2.4   File insert functions
  3.  
  4.  
  5. In the same way that MAXsBBS uses the '%' character to check for
  6. auto-inserted text, Maxi-Text uses the '╗' chracter, followed by an
  7. opening bracket, function, length, and a closing bracket.
  8.  
  9. Eg:
  10.  
  11. ╗(tun:20)
  12.  
  13. This will insert the 'Top Uploaders' name and make the name 20 characters
  14. long. This can cause the string to be truncated or padded with spaces.
  15.  
  16. ╗(tdn)
  17.  
  18. Will insert the 'Top Dowloaders' name, using the default length.
  19.  
  20.  
  21. All silly questions will be answered here.
  22.  
  23. Yes: You can still use MAXsBBS commands eg: like '%Z', Maxi-Text will
  24. simply pass them through.
  25.  
  26. There is a limit on all the differant functions of 30 users, if you need
  27. more then let me know. (except for 'Last User'). Do not try to go
  28. further than 30, as there is no bounds checking.
  29.  
  30. To use the start specifer '╗', use left-alt and 0 (top of keyboard, not
  31. numerical keypad). All functions MUST be surrounded by an opening and
  32. closing bracket '( )'. The start specifer should appear as 2 arrows
  33. pointing right, depending on your font.
  34.  
  35. If you want to use a size specifier you MUST put a ':' after the
  36. function, and before the size.
  37.  
  38. You may NOT put imbedded functions in, they will be ignored.
  39.  
  40. This program can be used on KickStart releases less than 36, as long as
  41. NO 'Last User' or 'Top Message Date and Time' functions are called.
  42.  
  43. These are the Maxi-Text functions, the default length is in characters.
  44. All strings left justified. Numeric values are right justified.
  45.  
  46. Numeric values are padded with spaces, not '0's.
  47.  
  48.  
  49.  
  50.                          Data Function format:
  51.                          ---------------------
  52.  
  53. ╗(3_character_function_name[:optional_size])    eg: ╗(tun:30)  or  ╗(tun)
  54.  
  55.  
  56.  
  57.                          Jump function format:
  58.                          ---------------------
  59. Forward and jumping:
  60.  
  61. ╗(2_character_header+[:optional_force_jump])    
  62.  
  63. Calling  ╗(tu+) will push the top uploader forward 1, or calling ╗(tu+:5)
  64. will push the top uploader to number 5.
  65.  
  66. All stats start at 0 when loaded, and must be pushed to 1 to start.
  67.  
  68.  
  69. Backward:
  70.  
  71. ╗(2_character_header-)
  72.  
  73. Calling ╗(tu-) will pull the top uploader back one, and will not push it
  74. back to less than the first entry. The back function doesn't support
  75. jumping, to jump to level use the '+' functions.
  76.  
  77. The '-' is supported so that list can be produced in reverse order.
  78.  
  79.  
  80.                         String duplicate format:
  81.                         ------------------------
  82.  
  83. ╗(*[duplicate])
  84.  
  85. This MUST be first on the line, the rest of the line will be duplicated
  86. the amount of times specified.
  87.  
  88. eg:
  89.  
  90. ╗(*10) ╗(tu+) ╗(tu?) ╗(tun)
  91.  
  92. Will list the top ten uploaders.
  93.  
  94.  
  95.                         Todays users duplicate:
  96.                         -----------------------
  97.  
  98. ╗(**)
  99.  
  100. This MUST be first on the line, the rest of the line will be duplicated
  101. for as many users that have been on the same day.
  102.  
  103. Only use 'Last User' function here, or it will not make sence.
  104.  
  105.  
  106.                           Full function list:
  107.                           -------------------
  108.  
  109.  
  110. Function name may be in upper or lower case.
  111.  
  112.  
  113. Function:       Description:                            Default length:
  114. ----------------------------------------------------------------------------
  115.  
  116. tu+             Goto next                       
  117. tu-             Go back 1
  118. tu?             Current number                          2
  119. tun             Name of top uploader                    40
  120. tuf             Number of files uploaded                5
  121.  
  122.  
  123. td+             Goto next
  124. td-             Go back 1
  125. td?             Current number                          2
  126. tdn             Name of top downloader                  40
  127. tdf             Number of files downloaded              5
  128.  
  129.  
  130. ta+             Goto next
  131. ta-             Go back 1
  132. ta?             Current number                          2
  133. tan             Name of top author                      40
  134. tam             Number of messages written              5
  135.  
  136.  
  137. tc+             Goto next
  138. tc-             Go back 1
  139. tc?             Current number                          2
  140. tcn             Name of top caller                      40
  141. tct             Number of times called                  5
  142.  
  143.  
  144. tr+             Goto next
  145. tr-             Go back 1
  146. tr?             Current number                          2
  147. trn             Name of top ratio holder                40 *
  148. trr             Ratio level of holder                   4
  149. tru             Holders uploads                         5
  150. trd             Holders downloads                       5
  151. trf             Files holder is in front of ratio       5
  152.  
  153. * Top ratio is based on : trf = (uploads X ratio) - downloads
  154.  
  155. If you run on a zero ratio system, don't use this function, as it will
  156. not generate a listing.
  157.  
  158. tl+             Goto next
  159. tl-             Go back 1
  160. tl?             Current number                          2
  161. tln             Name of top leech                       40 
  162. tlu             Holders uploads                         5
  163. tld             Holders downloads                       5
  164. tlf             Files downloaded more than uploaded     5
  165.  
  166.  
  167. tf+             Goto next
  168. tf-             Go back 1
  169. tf?             Current number                          2
  170. tfn             Top file downloaded                     40
  171. tfu             Top file uploader name                  40
  172. tft             Number of times downloaded              5
  173.  
  174.  
  175. tp+             Goto next
  176. tp-             Go back 1
  177. tp?             Current number                          2
  178. tpn             Top download cps name                   40
  179. tpr             Top cps rate                            4
  180.  
  181.  
  182. tm+             Goto next
  183. tm-             Go back 1
  184. tm?             Current number                          2
  185. tms             Top message subject                     40
  186. tmf             Top message from                        40
  187. tmd             Top message date                      # 9 dd-mmm-yy
  188. tmm             Top message time                      # 5 hh:mm     24hr
  189. tmt             Top message time                      # 8 hh:mm ?m  12hr
  190. tmr             Top message replies                     4
  191.  
  192. lu+             Goto next
  193. lu-             Go back 1
  194. lu?             Current number                          2
  195. lun             Last user name                          40
  196. lus             Last user suburb                        40
  197. luc             Last user computer                      20
  198. luu             Last user uploads                       5
  199. lud             Last user downloads                     5
  200. lur             Last user messages read                 5
  201. lul             Last user messages left                 5
  202. lub             Last user baud rate                   * 5
  203. luo             Last user online time                 # 5 hh:mm
  204. luf             Last user flags                    ** # 6 
  205.  
  206. lol             Last user logon time                  # 5 hh:mm     24hr
  207. lot             Last user logon time                  # 8 hh:mm ?m  12hr
  208. lod             Last user logon date                  # 9 dd-mmm-yy
  209. loy             Last user logon day                   # 9
  210.  
  211. lfl             Last user logoff time                 # 5 hh:mm     24hr
  212. lft             Last user logoff time                 # 8 hh:mm ?m  12hr
  213. lfd             Last user logoff date                 # 9 dd-mmm-yy
  214. lfy             Last user logoff day                  # 9 
  215.  
  216. ltu             Last user uploads       (total)         5
  217. ltd             Last user downloads     (total)         5
  218. ltm             Last user messages      (total)         5
  219. ltc             Last user calls         (total)         5
  220.  
  221. day             List Generation Day                   # 9
  222. dat             List Generation Date                  # 9 dd-mmm-yy
  223. fdt             List Generation Full Date             #25 day-month-year
  224. mon             List Generation Month                 # 8
  225. yer             List Generation Year                  # 4 XXXX
  226. 12h             List Generation 12 hour time          # 8 hh:mm ?m
  227. 24h             List Generation 24 hour time          # 5 hh:mm 
  228. sec             List Generation seconds               # 2 
  229.  
  230.  
  231.  
  232. Although the 'Last User' data is not stored in the Maxi-Text
  233. configuration file, it is very quick to access the data. However, if you
  234. use any of the functions that require infomation from the user.data,
  235. such as totals, suburb and computer. The access time will be much
  236. slower, as the data must be sought and retrieved.
  237.  
  238. # These functions cannot have their length changed in this release.
  239. Most of them will only make sense if they are left at their default
  240. lenghts anyway. All the time functions are at their minimum length, and
  241. the day strings are set for the longest day of the week string.
  242.  
  243. * For local logins, the baud rate will be shown as 'Local'. If you want
  244. to change it, use a hex editor!
  245.  
  246. ** Last user flags are a set amount of characters and should not be
  247. adjusted, the flags are - XRLUDP. If a field is blank, it will be
  248. shown as a '-'. These are the characters shown for each field;
  249.  
  250. X  Logoff type
  251.  
  252.         N - Normal
  253.         T - Twitted
  254.         S - Slow Baud
  255.         Z - Slow Login
  256.         D - Sleep Disconnect
  257.         L - Locked out
  258.         C - Lost carrier
  259.         H - Security violation
  260.         O - Out of time
  261.         B - BBS reserved / system event / forced hangup / userfile full
  262.         ? - System error.
  263.  
  264. R  Read messages
  265. L  Left messages
  266. U  Uploaded
  267. D  Downloaded
  268. P  Paged sysop
  269.  
  270.  
  271. You may use the last user functions as often as you like, they are
  272. limited only by the size of the log.data. If the Log.data runs out, it
  273. will return to the end and continue from there (Log.Data is read in
  274. reverse).
  275.  
  276.  
  277.                    Some Hints for speeding up Maxi-text
  278.  
  279.  
  280. Maxi-Text by it's nature is a slow program, because it reads such huge
  281. amounts of data to process the lists..
  282.  
  283. To speed up the proccessing, try these options:
  284.  
  285. If you don't want to use message funcitons, turn it off, as messages tend
  286. to be the largest files to process.
  287.  
  288. Set CPS and Files to NOT always update, while this may not be as accurate,
  289. it is much faster to do so.
  290.  
  291. Use the new 2.0 multiline functions, the line only needs to be read once
  292. and is duplicated from memory and saves a lot of disk overhead.
  293.  
  294. Try not to run the proram at every logoff, try only running it at a
  295. maintenance period.
  296.  
  297. Run Maxi-Text on your Cray-3 and port the data across.
  298.  
  299.  
  300.  
  301.  
  302.